Skip to content

Conversation

ehuss
Copy link
Contributor

@ehuss ehuss commented Aug 20, 2025

This changes all HTML IDs so that they have the mdbook- prefix. This should help avoid ID conflicts between internal IDs and IDs from user content such as section headers.

This is a relatively disruptive change and has a high risk of breaking something. However, I think I have covered everything, and if anything is missed, hopefully it will get detected.

I did not change class names since the chance of a collision is much smaller than with IDs. However, that is something that could be considered in the future.

Closes #880

This changes all HTML IDs so that they have the `mdbook-` prefix. This
should help avoid ID conflicts between internal IDs and IDs from user
content such as section headers.

This is a relatively disruptive change and has a high risk of breaking
something. However, I think I have covered everything, and if anything
is missed, hopefully it will get detected.

I did not change class names since the chance of a collision is much
smaller than with IDs. However, that is something that could be
considered in the future.

Closes rust-lang#880
@ehuss ehuss added the Breaking Change This would require a SemVer breaking change label Aug 20, 2025
@rustbot rustbot added the S-waiting-on-review Status: waiting on a review label Aug 20, 2025
@ehuss ehuss enabled auto-merge August 20, 2025 02:39
@ehuss ehuss added this pull request to the merge queue Aug 20, 2025
Merged via the queue into rust-lang:master with commit 0722d81 Aug 20, 2025
14 checks passed
@rustbot rustbot removed the S-waiting-on-review Status: waiting on a review label Aug 20, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Breaking Change This would require a SemVer breaking change
Projects
None yet
Development

Successfully merging this pull request may close these issues.

mdbook internal HTML id's conflict with header id's.
2 participants